home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / pop_202.zip / POPDOOR.DOC < prev    next >
Text File  |  1991-01-25  |  9KB  |  243 lines
  1.  
  2.                             POPDOOR!
  3.  
  4.            The Remote Access Most Popular DOOR Lister
  5.                                 
  6.             Written and Designed By Steven R. Hammond
  7.                    The ICE BBS! (416)471-1310
  8.                        Fido-net 1:250/505
  9.  
  10.  
  11. Introduction:
  12.  
  13.      The program came about one day while I was setting up some
  14. program that listed a list of best message writers etc, I thought
  15. it would be neat if there was something for the most popular door.
  16. Users could then play the one that is the most popular and the
  17. sysop could see which ones are just wasting space. 
  18.  
  19.      All the programs that I write are in protest of something
  20. called Crippleware. This is something I can not agree with. To
  21. write simple utilities like this one it only takes a small grasp of
  22. some compilable langauge and a bit of imagination. I hate when
  23. people write something that took them 2 hours and then cripple it
  24. and except us to pay for it. Put it in a store if you want us to
  25. buy it. I however agree with the Shareware concept. Remote Access
  26. took hundreds of hours to write and many people are responsible for
  27. its existence and its only 40 bucks and its not crippled.
  28.  
  29.      People like Alan Davenport the author of Yankee Trader, Trade
  30. Wars, Story Door, and more should be made a hero. Thousands of
  31. Hours of work went into Yankee Trader and he asks nothing in return
  32. but for you to enjoy it. The irony of it all is that Yankee Trader
  33. is the best and most popular game in the BBS world beating all
  34. Crippled Doors and Shareware doors. This is someone I model my code
  35. after. FREEWARE.
  36.  
  37.      If you find a program that you like, and its crippled  or
  38. shareware and it seems to be a simple program let me know and I
  39. might just write you the program for free. Together we can beat
  40. greedy shareware programmers.
  41.  
  42.      Whether you agree with me or not, please enjoy my programs,
  43. Its my gift to a hobby that has given me so much. (what a geek)
  44.  
  45.      Have fun.
  46.  
  47. Payment:
  48.  
  49.      The only payment I request for this is for you as a sysop to
  50. send me netmail(Which would cost only pennies for a medium sized
  51. message from anywhere in the world!). I want no money, no nothing,
  52. I just want to see where this gets. If you have no means of sending
  53. me net mail, drop a postcard in the mail and send it to
  54.  
  55.           Steven Hammond
  56.           25 Princess St
  57.           Markham, Ontario, Canada
  58.           L3P 1K4
  59.      (This would cost very little too!)
  60.  
  61.      Basically what I'm saying is, I want my ego inflated. <grin>
  62.  
  63.  
  64. Support:
  65.  
  66.      If you have any troubles with POPDOOR, write down in detail
  67. the problem that is occurring, and netmail my bbs with this
  68. information, I will assess the problem and correct it if necessary
  69. and release a updated version and send a copy directly to your bbs.
  70.  
  71. Suggestions:
  72.  
  73.      If you have any suggestions that you think would add to
  74. POPDOOR's usability, forward these comments also to my bbs via
  75. netmail.
  76.  
  77. Legalities
  78.  
  79.      This software and it's documentation is Copyright 1990 by
  80. Steven Hammond, All Rights are Reserved. By Executing this program
  81. you agree with this. If you do not, then don't run it!
  82.      You use this software at your own risk, any damage to files or
  83. software or hardware are not my fault. If you do not want to agree
  84. with this also then don't execute the code!
  85.      
  86.      Please, don't modify the code, I'm licensing it to you for
  87. free anyways!
  88.  
  89.      Any names which are not mine are copyright by their respectful
  90. owners except for Crippleware which is copyrighted by the "I'm a
  91. real jerk of a person, Inc."
  92.  
  93. The ZIP.
  94.  
  95.      The original zip contained:
  96.  
  97.      POPDOOR.EXE - the code
  98.      POPDOOR.DOC - the documentation
  99.      POPDOOR.CFG - Sample Configuration 
  100.      WHATNEW.??? - Whats new for this version ???.
  101.  
  102.      Any Archive containing anything else didn't come from my bbs.
  103.  
  104. Ok, now on to the documentation.
  105. Popdoor Limits
  106.  
  107.      The maximum number of Doors Popdoor handles is 100. If I find
  108. that a lot or who's kidding who one sysop says it needs more I will
  109. change it to be defined by POPDOOR.CFG.
  110.  
  111.      The Maximum number of Users popdoor handles is 1000. This
  112. should be enough.
  113.  
  114.      First off, unzip the archive where ever you want. I place it
  115. in its own directory, but its up to you.
  116.  
  117.      Then type this in.
  118.  
  119.      POPDOOR /I
  120.  
  121.      This initializes the POPDOOR.DAT file, and obviously also
  122. creates it. It also creates a POPUSER.DAT file.
  123.  
  124.      Popdoor Will read the type of log you are using from RACONFIG
  125. file. Whether it is OPUS or FrontDoor It does not matter. Make sure
  126. that no other Logs are defined as the same log file. Sometimes
  127. Sysops have frontdoor or filedoor using the same log file. It
  128. shouldn't create a problem but just to be sure.
  129.  
  130.      Then load up your favourite editor and edit the POPDOOR.CFG
  131. file.
  132.  
  133.      Valid lines in the POPDOOR.CFG file are
  134.  
  135.      ; - when placed at the start of a line means text following it
  136. is simply a remark made by you or me.
  137.  
  138.      SYSTEMPATH - This is the FULL PATH, (NO FILE NAME) to your
  139. remote access config file (CONFIG.RA). E.g. C:\RA\ or D:\ICEBBS\.
  140.      Popdoor get the following information from the Raconfig file.
  141. Gets the Path to the TEXT File Directory, Gets the Sysop Name,
  142. Gets the BBS name, Gets the flag that Excludes or Includes the
  143. Sysop in Listings.
  144.      
  145.      LOGFILE - this is the FULL PATH and FULL NAME of the Remote
  146. Access log file. E.g. C:\RA\RA.LOG or C:\MYBBS\SYSTEM.LOG
  147.  
  148.      USERS - This goes along with the POPUSER, if nothing is
  149. entered or this is not put in the config file POPDOOR will default
  150. to the top 15 users. E.g. USERS 10 or USERS 15 or USERS 20
  151.        
  152.      CLEARSCREEN - This is a YES or NO Answer anything else will be
  153. ignored and a YES will be defaulted. This flag simply tells popdoor
  154. whether you want a clearscreen code to be placed in the POPDOOR
  155. files and the POPUSER files.
  156.  
  157.      ENTER - This is a YES or NO Answer anything else will be
  158. ignored and a YES will be defaulted. This flag tells popdoor
  159. whether you want a 'Press ENTER to Continue' placed at the bottom
  160. of the POPDOOR and the POPUSER files.
  161.  
  162.      DOORNAME - This is the name of a door that your bbs is
  163. running, the way you want it to appear in the popfile. e.g. Yankee
  164. Trader or Global Warfare.
  165.  
  166.      DOORLOG - * * * * Important * * * * 
  167.  
  168.                This MUST FOLLOW the DOORNAME command in the Config
  169. file. This contains the unique appearance in the log file of the
  170. DOORNAME previous to it. e.g. Errorlevel 30 or GWF.BAT.
  171.  
  172.      An example of this would be.
  173.  
  174.      DOORNAME Yankee Trader
  175.      DOORLOG Errorlevel 30
  176.  
  177.      DOORNAME Global Warfare
  178.      DOORLOG Gwf.bat
  179.  
  180.      Don't worry about being upper or lower case, POPDOOR is NOT
  181. case sensitive. 
  182.  
  183.      If you are still lost, take a look at the sample configuration
  184. file I send along with POPDOOR, and you'll figure it out.
  185.  
  186.      If you add a DOOR after you've already started popdoor, IT
  187. MUST GO AT THE END of POPDOOR.CFG after all the other ones you've
  188. already put in POPDOOR.CFG.
  189.  
  190.      To delete a door, CHANGE THE NAME OF IT IN THE POPDOOR.CFG
  191. file to NONE and the LOGFILE to something that will never be found
  192. in the log file, like 123456789 or NOTHING or ZZZZZZZ etc.
  193.  
  194.      When you ADD a DOOR and you have a NONE somewhere in the
  195. POPDOOR.cfg file, simply use this space to add the new door instead
  196. of putting it at the end but either way will add the door to the
  197. list.
  198.  
  199.      ONCE POPDOOR HAS BEEN STARTED YOU MUST NOT CHANGE THE ORDER OF
  200. THE DOORS IN THE POPDOOR CONFIG FILE.
  201.  
  202.      If you are running a multi-line bbs, each line has its own log
  203. file. You can enter the name of the log file from the command line.
  204. Like this.
  205.  
  206.      POPDOOR C:\RA\LINE1\SYSTEM.LOG
  207.      or
  208.      POPDOOR c:\RA\LINE2\SYSTEM.LOG
  209.  
  210.      Otherwise popdoor will default to the name of the log file in
  211. the popdoor.cfg file. Also for MULTI LINE bbs, MAKE SURE THAT
  212. POPDOOR NEVER RUNS on 2 LINES AT THE SAME TIME. Popdoor is not
  213. multi task aware. Some sysops run popdoor after a user logs off. I
  214. would not recommend this on multi line bbs system.
  215.  
  216.      I hope you enjoy this utility and look for future
  217. enhancements.
  218.  
  219.      Steven Hammond
  220.      1:250/505
  221.      (416)471-1310
  222.      Sysop - Me
  223.  
  224.      I would like to thank the following BBS's for beta testing and
  225. putting up with all the changes I do.
  226.  
  227.      Buckingham Palace
  228.      1:123/22
  229.      (901)873-0860
  230.      Sysop - Kerry Buckingham
  231.      
  232.      The Intoxicated BBS
  233.      1:250/720
  234.      (416)630-7850
  235.      Sysop - Mark Bylok
  236.  
  237.  
  238.      To receive the latest version of POPDOOR request the MAGIC
  239. WORD -     POPDOOR    -  from anyone of the bbs's listed above.
  240.  
  241.  
  242.      
  243.